Skip to content

docs: upgrade mkdocs to fix dark mode custom highlight style #1695

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 19, 2023

Conversation

am29d
Copy link
Contributor

@am29d am29d commented Sep 19, 2023

Description of your changes

We had a custom css for code highlight in light mode which was also applied in the dark mode, making the code unreadable.
This issue has been fixed recently in this PR. We can now upgrade MkDocs to 9.3.2 and apply custom CSS only to light mode, leaving dark mode code highlight as default.

Related issues, RFCs

Issue number: closes #1693

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my change is effective and works
  • The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@am29d am29d requested a review from a team September 19, 2023 13:51
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Sep 19, 2023
@pull-request-size pull-request-size bot added the size/XS PR between 0-9 LOC label Sep 19, 2023
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@am29d am29d merged commit 0b399ea into main Sep 19, 2023
@am29d am29d deleted the 1693-docs-code-highlight-dark-mode branch September 19, 2023 13:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size/XS PR between 0-9 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: improve code highlight in dark mode
1 participant